[App Service] az webapp troubleshoot status: provide latest application startup attempt data#33673
Draft
aamos-company wants to merge 4 commits into
Draft
Conversation
aamos-company
requested review from
DanielMicrosoft,
NoriZC,
Pan-Qi,
VeryEarly,
YangAn-microsoft,
jsntcy,
necusjz,
teresaritorto,
yanzhudd and
yonzhan
as code owners
|
Validation for Azure CLI Full Test Starting...
Thanks for your contribution! |
|
Hi @aamos-company, |
|
Validation for Breaking Change Starting...
Thanks for your contribution! |
microsoft-github-policy-service
Bot
added
the
customer-reported
Contributor
|
Thank you for your contribution @aamos-company! We will review the pull request and get back to you soon. |
aamos-company
changed the title
az webapp troubleshoot: provide latest application startup attempt data
Contributor
There was a problem hiding this comment.
Pull request overview
This PR extends the App Service command module with new runtime-status troubleshooting capabilities by introducing a webapp status command (ARM siteStatus) and a preview webapp troubleshoot status command (ARM siteStatus + SCM startup summary), plus associated help, params, and tests.
Changes:
- Add
az webapp statusto fetch per-instance Site Runtime Status (ARMsiteStatus), including--instancefiltering and table formatting. - Add preview
az webapp troubleshoot statusto combine ARM runtime status with SCM startup summary, rendered as a human-readable report for table output. - Add scenario + mocked tests and a new recording; update HISTORY entry.
Reviewed changes
Copilot reviewed 7 out of 8 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| src/azure-cli/HISTORY.rst | Adds history note for the new az webapp status command. |
| src/azure-cli/azure/cli/command_modules/appservice/tests/latest/test_webapp_commands.py | Adds live scenario coverage for az webapp status. |
| src/azure-cli/azure/cli/command_modules/appservice/tests/latest/test_webapp_commands_thru_mock.py | Adds mocked unit tests for troubleshoot status, webapp status, and output transform behavior. |
| src/azure-cli/azure/cli/command_modules/appservice/tests/latest/recordings/test_webapp_status.yaml | Adds VCR recording for the new scenario test. |
| src/azure-cli/azure/cli/command_modules/appservice/custom.py | Implements show_webapp_status, troubleshoot_status, formatting, and status-tip logging. |
| src/azure-cli/azure/cli/command_modules/appservice/commands.py | Registers new commands and table transformers. |
| src/azure-cli/azure/cli/command_modules/appservice/_params.py | Adds --instance parameter wiring for webapp status and webapp troubleshoot status. |
| src/azure-cli/azure/cli/command_modules/appservice/_help.py | Adds help for webapp status and the preview webapp troubleshoot group/command. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| for item in runtime_items: | ||
| _fetch_startup_summary(item) | ||
|
|
||
| # --- 3. Assemble payload --- |
Collaborator
|
App Service |
aamos-company
changed the title
az webapp troubleshoot: provide latest application startup attempt dataaz webapp troubleshoot status: provide latest application startup attempt data
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Related command
Description
Introduces a new command group
az webapp troubleshootand its first command, az webapp troubleshoot status, which surfaces per-instance runtime health plus a 24-hour startup-attempt summary for a Linux web app.What's new
Command: az webapp troubleshoot status -n -g [--slot ] [--instance ] [--report]
• Data sources
• ARM GET /sites/{name}/instances → resolves user-supplied --instance (accepts either the hex ARM instanceId or the friendly machineName ) and pulls properties.machineName
• ARM GET /sites/{name}/siteStatus[/{instance}] → per-instance runtime state , action , details , lastError , lastErrorTimestamp .
• KuduLite GET /api/startuplogs/summary → 24 h startup-attempt counts and most-recent success/failure timestamps per worker, in a single unfiltered call (fanning out per-instance was 4 RTT with ThreadPoolExecutor ; this is 1 RTT regardless of N).
• Linux only — errors early on Windows with a clear message. Site Runtime Status is a Linux-only feature.
• Preview — command group registered as preview per RP guidelines.